Testing the API
This section provides information on how to test and interact with the Knowledge Enrichment APIs using popular HTTP request tools like Postman and Bruno.
Data Curation API Tools
Bruno: Collection Setup and Usage
The Bruno collection can be used to query the Data Curation API gateway to initiate and check the status of jobs. The collection includes an environment file for the production environment.
Visit the Bruno website to access the Bruno client. Additional information on using Bruno and running collections is also available in the Run a Collection section of the website.
The collection includes a complete workflow with requests for:
- Getting an authorization token
- Requesting pre-signed URLs for a job
- Uploading files to S3 for processing
- Checking job status
- Downloading the output from S3
You must unzip the collection before you start working. Configure your OAuth client credentials in Bruno's environment variables after importing.
Refer to the Tutorials chapter for detailed instructions on configuring users OAuth information and using the API.
Context API Tools
Bruno: Collection Setup and Usage
Download the Bruno collection guide for step-by-step instructions for uploading a file, processing it, and retrieving the results using the API with Bruno.
Postman: Collection Setup and Usage
Download the Postman collection guide for step-by-step for uploading a file, processing it, and retrieving the results using the API with Postman.